/*
 * Copyright 2002-2007 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the
 * License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */

package com.powersi.hygeia.framework.spring;

/**
 * Interface that defines common functionality for objects that can offer parameter values for named SQL parameters, serving as argument for operations.
 * 
 * <p>
 * This interface allows for the specification of SQL type in addition to parameter values. All parameter values and types are identified by specifying the name
 * of the parameter.
 * 
 * <p>
 * Intended to wrap various implementations like a Map or a JavaBean with a consistent interface.
 * 
 * @author Thomas Risberg
 * @author Juergen Hoeller
 * @since 2.0
 */
public interface SqlParameterSource {

    /**
     * Constant that indicates an unknown (or unspecified) SQL type. To be returned from <code>getType</code> when no specific SQL type known.
     * 
     * @see #getSqlType
     * @see java.sql.Types
     */
    // int TYPE_UNKNOWN = JdbcUtils.TYPE_UNKNOWN;
    int TYPE_UNKNOWN = Integer.MIN_VALUE;

    /**
     * Determine whether there is a value for the specified named parameter.
     * 
     * @param paramName
     *            the name of the parameter
     * @return whether there is a value defined
     */
    boolean hasValue(String paramName);

    /**
     * Return the parameter value for the requested named parameter.
     * 
     * @param paramName
     *            the name of the parameter
     * @return the value of the specified parameter
     * @throws IllegalArgumentException
     *             if there is no value for the requested parameter
     */
    Object getValue(String paramName) throws IllegalArgumentException;

    /**
     * Determine the SQL type for the specified named parameter.
     * 
     * @param paramName
     *            the name of the parameter
     * @return the SQL type of the specified parameter, or <code>TYPE_UNKNOWN</code> if not known
     * @see #TYPE_UNKNOWN
     */
    int getSqlType(String paramName);

    /**
     * Determine the type ane for the specified named parameter.
     * 
     * @param paramName
     *            the name of the parameter
     * @return the type name of the specified parameter, or <code>null</code> if not known
     */
    String getTypeName(String paramName);

}
